Skip to content

add additional information on dealing with ~/.ssh/config errors on Mac#6061

Merged
skedwards88 merged 3 commits intogithub:mainfrom
michaellihs:patch-1
May 7, 2021
Merged

add additional information on dealing with ~/.ssh/config errors on Mac#6061
skedwards88 merged 3 commits intogithub:mainfrom
michaellihs:patch-1

Conversation

@michaellihs
Copy link
Copy Markdown
Contributor

Given the many upvotes on this post on StackOverflow https://stackoverflow.com/questions/47455300/ssh-config-bad-configuration-option-usekeychain-on-mac-os-sierra-10-12-6 it seems like many users have an issue with Mac not dealing properly with the UseKeychain config in the ~/.ssh/config. This commit adds additional information on how to fix the problem and allows GitHub users to find a solution in the GitHub documentation when searching for the error message.

Why:

Given the many upvotes on this post on StackOverflow https://stackoverflow.com/questions/47455300/ssh-config-bad-configuration-option-usekeychain-on-mac-os-sierra-10-12-6 it seems like many users have an issue with Mac not dealing properly with the UseKeychain config in the ~/.ssh/config. This commit adds additional information on how to fix the problem and allows GitHub users to find a solution in the GitHub documentation when searching for the error message.

What's being changed:

Add additional information for Mac users on how to fix the ~/.ssh/config configuration on their Macs. Diff should be self-explanatory.

Check off the following:

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (eg. a "before and after video")

Given the many upvotes on this post on StackOverflow https://stackoverflow.com/questions/47455300/ssh-config-bad-configuration-option-usekeychain-on-mac-os-sierra-10-12-6 it seems like many users have an issue with Mac not dealing properly with the `UseKeychain` config in the `~/.ssh/config`. This commit adds additional information on how to fix the problem and allows GitHub users to find a solution in the GitHub documentation when searching for the error message.
@welcome
Copy link
Copy Markdown

welcome Bot commented May 5, 2021

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label May 5, 2021
@janiceilene
Copy link
Copy Markdown
Contributor

@michaellihs Thanks so much for opening a PR! I'll get this triaged for review ⚡

@janiceilene janiceilene added ssh Content related to SSH waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels May 5, 2021
@skedwards88 skedwards88 self-assigned this May 7, 2021
@skedwards88 skedwards88 dismissed a stale review via 7fc571e May 7, 2021 22:38
Copy link
Copy Markdown
Contributor

@skedwards88 skedwards88 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✨ Thank you for this addition! We have a liquid tag that enables you to display OS-specific content, so I applied this to your PR.

I'll get this merged down for you.

@skedwards88 skedwards88 enabled auto-merge (squash) May 7, 2021 22:44
@skedwards88 skedwards88 added the ready to merge This pull request is ready to merge label May 7, 2021
@github-actions github-actions Bot removed the waiting for review Issue/PR is waiting for a writer's review label May 7, 2021
@skedwards88 skedwards88 merged commit 416f87a into github:main May 7, 2021
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 7, 2021

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

@michaellihs
Copy link
Copy Markdown
Contributor Author

✨ Thank you for this addition! We have a liquid tag that enables you to display OS-specific content, so I applied this to your PR.

I'll get this merged down for you.

Thanks for letting me know and thanks for merging :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready to merge This pull request is ready to merge ssh Content related to SSH

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants